Add linter documentation #59
Conversation
- Update sidebar positions in documentation guides
Deploying coderabbit-docs with
|
| Latest commit: |
9276d99
|
| Status: | ✅ Deploy successful! |
| Preview URL: | https://8be9dfb0.coderabbit-docs.pages.dev |
| Branch Preview URL: | https://hasit-tools-doc.coderabbit-docs.pages.dev |
WalkthroughThe updates introduce new guides for various linters and static analysis tools within the Changes
TipsChatThere are 3 ways to chat with CodeRabbit:
Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments. CodeRabbit Commands (invoked as PR comments)
Additionally, you can add CodeRabbit Configration File (
|
![coderabbitaidev[bot]](https://avatars.githubusercontent.com/in/375467?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 0
Outside diff range, codebase verification and nitpick comments (1)
docs/guides/tools/linters.md (1)
23-35: Checking Tool Output section looks good, but fix the spelling issue.The information on how to check the tool output is clear and concise. However, the word "nit-picky" should be spelled as "nitpicky".
- Assertive - Yields more feedback, that may be considered nit-picky. + Assertive - Yields more feedback, that may be considered nitpicky.
Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Files ignored due to path filters (1)
docs/guides/tools/_category_.ymlis excluded by!**/*.ymland included by none
Files selected for processing (6)
- docs/guides/commands.md (1 hunks)
- docs/guides/delete-account.md (1 hunks)
- docs/guides/ondemand-reports.md (2 hunks)
- docs/guides/review-instructions.md (1 hunks)
- docs/guides/tools/linters.md (1 hunks)
- docs/guides/tools/ruff.md (1 hunks)
Files skipped from review due to trivial changes (4)
- docs/guides/commands.md
- docs/guides/delete-account.md
- docs/guides/ondemand-reports.md
- docs/guides/review-instructions.md
Additional context used
LanguageTool
docs/guides/tools/linters.md
[misspelling] ~19-~19: This word is normally spelled as one.
Context: ...s more feedback, that may be considered nit-picky. Apart from the overall profile, you c...(EN_COMPOUNDS_NIT_PICKY)
Additional comments not posted (9)
docs/guides/tools/linters.md (4)
1-6: Header section looks good.The metadata for the documentation is correctly set.
8-8: Overview section looks good.The description of CodeRabbit's supported linters and security analysis tools is clear and concise.
10-12: Enabling/Disabling Tools section looks good.The information on how to enable or disable tools is clear and concise.
14-21: Customizing Tools section looks good.The information on how to customize the tools is clear and concise.
Tools
LanguageTool
[misspelling] ~19-~19: This word is normally spelled as one.
Context: ...s more feedback, that may be considered nit-picky. Apart from the overall profile, you c...(EN_COMPOUNDS_NIT_PICKY)
docs/guides/tools/ruff.md (5)
1-6: Header section looks good.The metadata for the documentation is correctly set.
8-8: Overview section looks good.The description of Ruff is clear and concise.
10-17: Settings section looks good.The information on the settings supported by Ruff is clear and concise.
18-118: Default Settings section looks good.The information on the default settings used by CodeRabbit if no config file is found is clear and concise.
120-122: Links section looks good.The links to additional resources are correctly provided.
There was a problem hiding this comment.
Actionable comments posted: 0
Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Files selected for processing (3)
- docs/guides/tools/markdownlint.md (1 hunks)
- docs/guides/tools/ruff.md (1 hunks)
- docs/guides/tools/shellcheck.md (1 hunks)
Files skipped from review due to trivial changes (2)
- docs/guides/tools/markdownlint.md
- docs/guides/tools/shellcheck.md
Files skipped from review as they are similar to previous changes (1)
- docs/guides/tools/ruff.md
There was a problem hiding this comment.
Actionable comments posted: 1
Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Files selected for processing (5)
- docs/guides/tools/languagetool.md (1 hunks)
- docs/guides/tools/markdownlint.md (1 hunks)
- docs/guides/tools/ruff.md (1 hunks)
- docs/guides/tools/shellcheck.md (1 hunks)
- docs/guides/tools/tools.md (1 hunks)
Files skipped from review due to trivial changes (1)
- docs/guides/tools/languagetool.md
Files skipped from review as they are similar to previous changes (3)
- docs/guides/tools/markdownlint.md
- docs/guides/tools/ruff.md
- docs/guides/tools/shellcheck.md
Additional context used
LanguageTool
docs/guides/tools/tools.md
[misspelling] ~19-~19: This word is normally spelled as one.
Context: ...s more feedback, that may be considered nit-picky. Apart from the overall profile, you c...(EN_COMPOUNDS_NIT_PICKY)
Additional comments not posted (5)
docs/guides/tools/tools.md (5)
1-6: LGTM!The header section is correct and complete.
8-8: LGTM!The introduction is clear and concise.
10-12: LGTM!The explanation for enabling/disabling tools is clear and provides the necessary information.
23-35: LGTM!The explanation for checking tool output is clear and provides the necessary information. The example provided is helpful.
37-39: LGTM!The list of supported tools is clear and provides the necessary information.
There was a problem hiding this comment.
Actionable comments posted: 2
Outside diff range, codebase verification and nitpick comments (1)
docs/guides/tools/biome.md (1)
1-6: Improve the description.The description could be more informative. Consider adding more details about what Biome is and its purpose.
- description: CodeRabbit's guide to Biome. + description: CodeRabbit's guide to Biome, a linter for JavaScript, TypeScript, JSX, TSX, JSON, JSONC, and CSS files.
Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Files selected for processing (2)
- docs/guides/tools/biome.md (1 hunks)
- docs/guides/tools/languagetool.md (1 hunks)
Files skipped from review due to trivial changes (1)
- docs/guides/tools/languagetool.md
Additional context used
LanguageTool
docs/guides/tools/biome.md
[uncategorized] ~8-~8: You might be missing the article “a” here.
Context: ...5 --- Biome is linter for JavaScript, TypeScript, JSX, TSX, J...(AI_EN_LECTOR_MISSING_DETERMINER_A)
Additional comments not posted (2)
docs/guides/tools/biome.md (2)
10-24: LGTM!The list of supported file extensions is comprehensive and correct.
196-198: LGTM!The link to the Biome configuration documentation is correct.
There was a problem hiding this comment.
Actionable comments posted: 0
Outside diff range, codebase verification and nitpick comments (2)
docs/guides/tools/tools.md (2)
19-19: Fix the spelling issue.The word "nit-picky" should be spelled as "nitpicky".
- - `Assertive` - Yields more feedback, that may be considered nit-picky. + - `Assertive` - Yields more feedback, that may be considered nitpicky.Tools
LanguageTool
[misspelling] ~19-~19: This word is normally spelled as one.
Context: ...s more feedback, that may be considered nit-picky. Apart from the overall profile, you c...(EN_COMPOUNDS_NIT_PICKY)
25-25: Improve clarity of the phrase.Consider rephrasing "under 'Review details' comment" to "under the 'Review details' comment" for better clarity.
- attach the output under "Review details" comment in the change request. + attach the output under the "Review details" comment in the change request.Tools
LanguageTool
[uncategorized] ~25-~25: You might be missing the article “the” here.
Context: ...nge request and attach the output under "Review details" comment in the change re...(AI_EN_LECTOR_MISSING_DETERMINER_THE)
Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Files ignored due to path filters (1)
docs/guides/tools/_category_.ymlis excluded by!**/*.ymland included by none
Files selected for processing (5)
- docs/guides/tools/biome.md (1 hunks)
- docs/guides/tools/hadolint.md (1 hunks)
- docs/guides/tools/markdownlint.md (1 hunks)
- docs/guides/tools/ruff.md (1 hunks)
- docs/guides/tools/tools.md (1 hunks)
Files skipped from review due to trivial changes (1)
- docs/guides/tools/hadolint.md
Files skipped from review as they are similar to previous changes (3)
- docs/guides/tools/biome.md
- docs/guides/tools/markdownlint.md
- docs/guides/tools/ruff.md
Additional context used
LanguageTool
docs/guides/tools/tools.md
[misspelling] ~19-~19: This word is normally spelled as one.
Context: ...s more feedback, that may be considered nit-picky. Apart from the overall profile, you c...(EN_COMPOUNDS_NIT_PICKY)
[uncategorized] ~25-~25: You might be missing the article “the” here.
Context: ...nge request and attach the output under "Review details" comment in the change re...(AI_EN_LECTOR_MISSING_DETERMINER_THE)
Additional comments not posted (1)
docs/guides/tools/tools.md (1)
1-6: Metadata setup looks good.The metadata for the documentation page is correctly formatted.
There was a problem hiding this comment.
Actionable comments posted: 0
Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Files selected for processing (1)
- docs/guides/tools/biome.md (1 hunks)
Files skipped from review as they are similar to previous changes (1)
- docs/guides/tools/biome.md
There was a problem hiding this comment.
Actionable comments posted: 0
Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Files selected for processing (1)
- docs/guides/tools/swiftlint.md (1 hunks)
Files skipped from review due to trivial changes (1)
- docs/guides/tools/swiftlint.md
There was a problem hiding this comment.
Actionable comments posted: 1
Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Files selected for processing (4)
- docs/guides/tools/golangci-lint.md (1 hunks)
- docs/guides/tools/phpstan.md (1 hunks)
- docs/guides/tools/swiftlint.md (1 hunks)
- docs/guides/tools/tools.md (1 hunks)
Files skipped from review due to trivial changes (2)
- docs/guides/tools/golangci-lint.md
- docs/guides/tools/phpstan.md
Files skipped from review as they are similar to previous changes (1)
- docs/guides/tools/swiftlint.md
Additional context used
LanguageTool
docs/guides/tools/tools.md
[misspelling] ~19-~19: This word is normally spelled as one.
Context: ...s more feedback, that may be considered nit-picky. Apart from the overall profile, you c...(EN_COMPOUNDS_NIT_PICKY)
Additional comments not posted (3)
docs/guides/tools/tools.md (3)
10-12: LGTM!The instructions for enabling/disabling tools are clear and concise.
23-25: LGTM!The instructions for checking tool output are clear and concise.
37-46: LGTM!The list of supported tools is clear and concise.
There was a problem hiding this comment.
Actionable comments posted: 1
Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Files selected for processing (2)
- docs/guides/tools/tools.md (1 hunks)
- docs/guides/tools/yamllint.md (1 hunks)
Files skipped from review due to trivial changes (1)
- docs/guides/tools/yamllint.md
Additional context used
LanguageTool
docs/guides/tools/tools.md
[misspelling] ~19-~19: This word is normally spelled as one.
Context: ...s more feedback, that may be considered nit-picky. Apart from the overall profile, you c...(EN_COMPOUNDS_NIT_PICKY)
Additional comments not posted (5)
docs/guides/tools/tools.md (5)
1-6: Metadata section looks good.The title, sidebar label, description, and sidebar position are correctly defined.
8-9: Introduction section looks good.The introduction clearly explains the purpose of the supported tools.
10-12: Enabling/Disabling Tools section looks good.The instructions for enabling or disabling tools are clear and detailed.
23-35: Checking Tool Output section looks good.The instructions for checking the tool output are clear and the example provided is helpful.
37-48: Supported Tools section looks good.The list of supported tools is comprehensive and the links are correctly formatted.
* Add linter documentation - Update sidebar positions in documentation guides * docs: Move linter documentation to tools folder * Add more tools * Add LanguageTool documentation and configuration * Update Biome documentation and configuration * docs: Update linter documentation and configuration * chore: Update tools category label in _category_.yml * chore: Update tools category label and add new tools * docs: Fix typo in Biome linter documentation * chore: Add SwiftLint documentation and configuration * Add golangci-lint, PHPStan, and SwiftLint documentation and configuration * Add Yamllint documentation and configuration * Add Checkov and Gitleaks documentation and configuration
* Coderabbit Docs Rework (wip) * WIP blog page * Fixed images * Wip added all blogs and docs * ✏️ Remove asterisk from CodeRabbit heading * Add Tailwind CSS configuration and update page title * Update logo href and navbar styling * Update Docusaurus configuration and custom CSS * Update routing and styling * Add sitemap configuration and update redirect paths * blog: cost effective generative ai app * fix: numbering * Update CodeRabbit links in documentation * Update CodeRabbit documentation * Update base URL and redirect to external documentation * Update links to Get Started page * Add new images and update links in docusaurus.config.ts and sidebars.ts * Add redirect to documentation page * Update slug in introduction.md * Update introduction.md and docusaurus.config.ts, delete index.tsx * Add code to change the docs link on the navbar * Remove unnecessary code and add redirect for docs * Update docs link and hide SVG icon * Adjustments for mobile view in custom.css * Update logo size and padding for smaller screens, center Discord link, and hide certain navbar links on mobile * Update image paths in CodeRabbit deep dive blog post * Update image in introduction.md * Update image URL in blog post * Update favicon links in blog post * Update og:image URL in blog post * Update blog post image URLs * Update image URLs in blog posts * feat: added document under integration on integration with self hosted gitlab * Update docs/integrations/self-hosted-gitlab.md Co-authored-by: Karan Singh <[email protected]> * Update docs/integrations/self-hosted-gitlab.md Co-authored-by: Karan Singh <[email protected]> * Update docs/integrations/self-hosted-gitlab.md Co-authored-by: Karan Singh <[email protected]> * Update docs/integrations/self-hosted-gitlab.md Co-authored-by: Karan Singh <[email protected]> * Update docs/integrations/self-hosted-gitlab.md Co-authored-by: Karan Singh <[email protected]> * Update docs/integrations/self-hosted-gitlab.md Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com> * Update docs/integrations/self-hosted-gitlab.md Co-authored-by: Karan Singh <[email protected]> * Update self-hosted-gitlab.md * blog: modern ai stack for devs * citation: codex model use in gh copilot * fix: gh citation link * fix: typo * fix: typo * Update index.md * founderblogmissing * Remove markdown file * Update CodeRabbit description and add privacy and security information * Update link in introduction.md * nit * Add new images and delete old image files * Update self-hosted-gitlab.md * Update customize-coderabbit.md * Update self-hosted-gitlab.md * Update customize-coderabbit.md * format blog file * format all blog files * hide version 1 schema * Update faq.md * Fix images for light and dark mode. Made improvements to docs (#22) * Add ast-grep documentation page * Update the ast-grep documentation to include the coderabbit config file changes * Fix language review * Update coderabbit.yaml schema for ast-grep tool naming * Update coderabbig guide page with new coderabbit.yaml changes * Update 2023-11-13-boosting-engineering-efficiency.md * Move ast-grep documentation under the prompt-customization page * Change ast-grep naming * Correct grammar for ast-grep documentation * update faqs * restructure existing blog posts * Add ast-grep documentation page * Update the ast-grep documentation to include the coderabbit config file changes * Fix language review * Update coderabbit.yaml schema for ast-grep tool naming * Move ast-grep documentation under the prompt-customization page * restructure existing docs * review feedback * add preview image * use directory instead of folder terminology * nit * add disqus comments * fix admonitions * add fn acquisition blog (#27) * add fn acquisition blog * add links * small fix * update blog post * update blog post * update preview image * update preview image * minor update to the FAQ * Daily Standup Reporting Docs (#28) * Add daily standup reporting docs and images * Coderabbit suggestions * Add packages section and update existing docs for ast-grep (#29) * updateschemaexample (#31) * updateschemaexample * Update customize-coderabbit.md * minorchanges (#32) * updatefaq * FAQs * doc fixes (#33) Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com> --------- Co-authored-by: Gur singh <[email protected]> Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com> * fix path instructions example * change the default example for coderabbit yaml * Blog - AI Code Reviews (#36) * newblog * RenameFolder * updatedesc * update example * blog home page * blog featured posts * AdminAccessToken * FixCasing * updatecasing * update docs * update schema * remove daily standup guide * Update YAML settings in configure-coderabbit.md (#40) * Update YAML settings in configure-coderabbit.md * Add configuration for `languagetool` integration in configure-coderabbit.md * update pricing * remove pnpm * ast-grep update * update knowledge_base settings * mention ast-grep-essentials * add review.profile to docs * update review status * revert review status change * add quotes * minor * improve config docs * add playground link * placeholder for high-level summary * remove v1 config documentation * remove ignore title example * remove ignore title example * UpatePauseCommandMessage * update docs * Update introduction.md * Add config for biome and hadolint (#43) * update auto_incremental_review * improve config docs * chore: Update CodeRabbit configuration settings (#44) * chore: Add config for new tools (#45) * UpdateDataPrivacy * chore: Update SwiftLint configuration file path (#47) * Update self hosted onboarding guide * update auto title * update phpstan instructions * Update npm dependencies and add docusaurus-json-schema-plugin (#49) * Update npm dependencies and add docusaurus-json-schema-plugin * Show CodeRabbit config schema from a file * Update faqs typos (#51) * ♻️ Clean faq typos * 💄 Update .png for support help dark and light mode * ♻️ Misc fixes and improvements * update docs * Create initial Gitlab Saas integration page * Update GitLab page content on the how to section with a note * add tip * update limits * 📝 Add Documentation for Deleting Account (#55) * On-demand report generation docs (#56) * Ondemand report input schema format * On-demand reporting docs * CodeRabbit suggestions * Typo * Add linter documentation (#59) * Add linter documentation - Update sidebar positions in documentation guides * docs: Move linter documentation to tools folder * Add more tools * Add LanguageTool documentation and configuration * Update Biome documentation and configuration * docs: Update linter documentation and configuration * chore: Update tools category label in _category_.yml * chore: Update tools category label and add new tools * docs: Fix typo in Biome linter documentation * chore: Add SwiftLint documentation and configuration * Add golangci-lint, PHPStan, and SwiftLint documentation and configuration * Add Yamllint documentation and configuration * Add Checkov and Gitleaks documentation and configuration * Update tool configuration documentation (#60) * chore: Update tool configuration documentation * Update tool configuration documentation * Update Gitleaks documentation (#61) * Update introduction.md and add video (#62) * Add table for Supported Tools by languages (#63) * Add table for Supported Tools by languages * Update supported tools table and documentation * Update tool configuration documentation * Update introduction and CodeRabbit documentation (#64) * Update introduction and CodeRabbit documentation * Update FAQ documentation * Update CodeRabbit documentation and remove reference to GitHub Copilot * Update CodeRabbit documentation and remove reference to GitHub Copilot * Update default settings for CodeRabbit tools (#65) * feat: added docs for detekt and eslint (#67) * feat: added docs for detekt and eslint * fix: lint * Add segment script and update iframe attributes for YouTube video player (#68) * Improve Documentation Structure and Accessibility in Markdown Files (#69) * Major refactor - Move configure and tools to top level - Update category positions - Move images to static dir - Update links * Update image file name in introduction.md * Update sidebar positions for integrations documentation * Update category positions for documentation * Update knowledge base integration description * Update FAQ with CodeRabbit comparison and CodeRabbit's uniqueness * Update redirects in docusaurus.config.ts * Update Jira and Linear integration configuration in knowledge base * Update GitLab integration documentation * Self-Hosted GitHub onboarding docs (#66) * Initial draft of Self-Hosted GitHub onboarding * Fix issues and reorg steps * Rebase & fix conflicts * sidebar_position * Add step to install GitHub App for Self-Hosted (#70) * Add step to install GitHub App * Disclaimer * Coderabbit suggestion: install -> installation * Coderabbit suggestions * Remove ESLint from JavaScript tools documentation (#71) * Add supported git platforms page in documentation (#72) * Add supported git platforms page in documentation * Fix typo in platforms.md * chore: Update redirect paths in docusaurus.config.ts * added yaml editor (#74) * added yaml editor * name fix * moved component to one code block * removed logs * Feature yaml editor (#76) * added yaml editor * name fix * moved component to one code block * removed logs * fix: yaml editor * fix: reviews * new line * fix: merge fix * Update schema.v2.json * 🎨 Run Markdownlint and Prettier (#84) * added correct scopes (#88) Co-authored-by: dikshant <[email protected]> * Add Azure DevOps initial docs page * Update Azure DevOps * add redirect * rename AzureDevOps page * SaaS GitLab change to Gitlab.com and added relevant redirect Update GitLab sidebar label and link references in documentation (#93) * SaaS GitLab change to Gitlab.com and added relevant redirect * changes for the self-hosted-github to Github Enterprise Server * Azure DevOps Server Support * Update platforms.md * Remove segment (#104) * update: introduction and added a CTA minor change to recreate the PR --------- Co-authored-by: Karan Singh <[email protected]> Co-authored-by: gitcommitshow <[email protected]> Co-authored-by: coderabbit-amank <[email protected]> Co-authored-by: Gur singh <[email protected]> Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com> Co-authored-by: Gur <[email protected]> Co-authored-by: Harjot Gill <[email protected]> Co-authored-by: Karan Singh <[email protected]> Co-authored-by: petrisorcoderabbit <[email protected]> Co-authored-by: Jaseel <[email protected]> Co-authored-by: petrisorcoderabbit <[email protected]> Co-authored-by: Hasit Mistry <[email protected]> Co-authored-by: Hasit Mistry <[email protected]> Co-authored-by: Ruhan Muzaffar <[email protected]> Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com> Co-authored-by: Nato Boram <[email protected]> Co-authored-by: dikshant-infracloud <[email protected]> Co-authored-by: dikshant <[email protected]> Co-authored-by: Aravind Putrevu <[email protected]> Co-authored-by: Nick Busey <[email protected]>
Summary by CodeRabbit